Skip to content

docs: clarify RPM usage and deployment methods in README#58

Merged
alexlovelltroy merged 1 commit into
mainfrom
docs/clarify-rpm-usage
Jun 5, 2026
Merged

docs: clarify RPM usage and deployment methods in README#58
alexlovelltroy merged 1 commit into
mainfrom
docs/clarify-rpm-usage

Conversation

@alexlovelltroy

Copy link
Copy Markdown
Member

Description

This pull request updates the README.md to clarify the purpose of the repository, provide context on deployment methods, and improve guidance for new users. The changes focus on making it clear that this repository provides an RPM for quadlet-based deployment of OpenCHAMI microservices, and that OpenCHAMI itself is composed of independently released components. It also introduces a new section outlining all recommended deployment methods.

Documentation and user guidance improvements:

  • Updated the introduction to clarify that the repository provides an RPM for deploying OpenCHAMI services as Podman Quadlets, and that OpenCHAMI microservices are released independently rather than as a single product.
  • Added a new "OpenCHAMI Deployment Methods" section with a comparison table of recommended deployment options, including links and descriptions for each method, to help users select the appropriate approach.
  • Improved recommendations for new users, suggesting they start with the Tutorial before considering other deployment methods.

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

For more info, see Contributing Guidelines.

Signed-off-by: Alex Lovell-Troy <alovelltroy@lanl.gov>
@alexlovelltroy alexlovelltroy requested a review from rainest June 5, 2026 17:33

@j0hnL j0hnL left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great updates. looks good

@davidallendj davidallendj left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@alexlovelltroy alexlovelltroy merged commit f1e7be9 into main Jun 5, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants